/*
 * Copyright (c) 2014. Real Time Genomics Limited.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.rtg.util.io;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.OutputStream;

/**
 * {@link BufferedOutputStream} extends {@link java.io.FilterOutputStream} which (in Java 7) has a serious bug in it's close
 * method (silently ignores IOException). This class provides a working version. The bug has been fixed in Java 8.
 */
public class BufferedOutputStreamFix extends BufferedOutputStream {

  private boolean mClosed = false;

  /**
   * @param out {@link BufferedOutputStream#BufferedOutputStream(java.io.OutputStream)}
   */
  public BufferedOutputStreamFix(OutputStream out) {
    super(out);
  }

  /**
   * @param out {@link BufferedOutputStream#BufferedOutputStream(java.io.OutputStream)}
   * @param size {@link BufferedOutputStream#BufferedOutputStream(java.io.OutputStream)}
   */
  public BufferedOutputStreamFix(OutputStream out, int size) {
    super(out, size);
  }

  @Override
  @SuppressWarnings("try")
  public void close() throws IOException {
    if (!mClosed) {
      mClosed = true;
      try (OutputStream ignored = out) {
        flush();
      }
    }
  }
}
